fix: documentation of template.md #8849

filzrev · 2023-06-07T02:58:19Z

Documentation fix related to #8847

If templates is specified instead of template in docfx.json build config,
It is ignored by deserializer and fallback to default template.

docfx/src/Microsoft.DocAsCode.App/Config/BuildJsonConfig.cs

Lines 68 to 69 in ffabd3d

    
           [JsonProperty("template")] 
        
           public ListWithStringFallback Templates { get; set; } = new ListWithStringFallback();

docfx/src/Microsoft.DocAsCode.App/RunBuild.cs

Lines 14 to 17 in ffabd3d

    
           if (config.Templates == null || config.Templates.Count == 0) 
        
           { 
        
               config.Templates = new ListWithStringFallback { DocAsCode.Constants.DefaultTemplateName }; 
        
           }

dotnet#8847

yufeih

Thank you @filzrev ! Nice catch.

Update template.md

5350cfd

dotnet#8847

yufeih approved these changes Jun 7, 2023

View reviewed changes

yufeih merged commit f5bcfb9 into dotnet:main Jun 7, 2023

yufeih added the documentation Improvements or additions to documentation and the project website label Jun 7, 2023

filzrev deleted the patch-1 branch June 17, 2023 07:40

p-kostov pushed a commit to ErpNetDocs/docfx that referenced this pull request Jun 28, 2024

fix: documentation of template.md (dotnet#8849)

c6aa27b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: documentation of template.md #8849

fix: documentation of template.md #8849

filzrev commented Jun 7, 2023

yufeih left a comment

	[JsonProperty("template")]
	public ListWithStringFallback Templates { get; set; } = new ListWithStringFallback();

	if (config.Templates == null \|\| config.Templates.Count == 0)
	{
	config.Templates = new ListWithStringFallback { DocAsCode.Constants.DefaultTemplateName };
	}

fix: documentation of template.md #8849

fix: documentation of template.md #8849

Conversation

filzrev commented Jun 7, 2023

yufeih left a comment

Choose a reason for hiding this comment